<!doctype html>
<html lang="en" class="no-js">

  <!-- Mirrored from flatbuffers.dev/annotation/ by HTTrack Website Copier/3.x [XR&CO'2014], Thu, 08 May 2025 07:01:36 GMT -->
  <!-- Added by HTTrack --><meta http-equiv="content-type"
    content="text/html;charset=utf-8" /><!-- /Added by HTTrack -->
  <head>

    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">

    <link rel="canonical" href="index.html">

    <link rel="prev" href="../intermediate_representation/index.html">

    <link rel="next" href="../benchmarks/index.html">

    <link rel="icon" href="../assets/images/favicon.png">
    <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.9">

    <title>注释缓冲区（Annotating Buffers）(.afb) - FlatBuffers 文档（Docs）</title>

    <link rel="stylesheet" href="../assets/stylesheets/main.4af4bdda.min.css">

    <link rel="stylesheet"
      href="../assets/stylesheets/palette.06af60db.min.css">

    <link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
    <link rel="stylesheet"
      href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&amp;display=fallback">
    <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>

    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>

  </head>

  <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo"
    data-md-color-accent="indigo">

    <input class="md-toggle" data-md-toggle="drawer" type="checkbox"
      id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox"
      id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">

      <a href="#annotating-flatbuffers" class="md-skip">
        跳转到内容（Skip to content）
      </a>

    </div>
    <div data-md-component="announce">

    </div>

    <header class="md-header md-header--shadow" data-md-component="header">
      <nav class="md-header__inner md-grid" aria-label="Header">
        <a href="../index.html" title="FlatBuffers 文档（Docs）"
          class="md-header__button md-logo" aria-label="FlatBuffers 文档（Docs）"
          data-md-component="logo">

          <img src="../assets/flatbuffers_logo.svg" alt="logo">

        </a>
        <label class="md-header__button md-icon" for="__drawer">

          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path
              d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z" /></svg>
        </label>
        <div class="md-header__title" data-md-component="header-title">
          <div class="md-header__ellipsis">
            <div class="md-header__topic">
              <span class="md-ellipsis">
                FlatBuffers 文档（Docs）
              </span>
            </div>
            <div class="md-header__topic" data-md-component="header-topic">
              <span class="md-ellipsis">

                注释缓冲区（Annotating Buffers）(.afb)

              </span>
            </div>
          </div>
        </div>

        <form class="md-header__option" data-md-component="palette">

          <input class="md-option" data-md-color-media
            data-md-color-scheme="default" data-md-color-primary="indigo"
            data-md-color-accent="indigo" aria-label="切换到深色模式"
            type="radio" name="__palette" id="__palette_0">

          <label class="md-header__button md-icon" title="切换到深色模式"
            for="__palette_1" hidden>
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path
                d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z" /></svg>
          </label>

          <input class="md-option" data-md-color-media
            data-md-color-scheme="slate" data-md-color-primary="indigo"
            data-md-color-accent="indigo" aria-label="切换到浅色模式"
            type="radio" name="__palette" id="__palette_1">

          <label class="md-header__button md-icon" title="切换到浅色模式"
            for="__palette_0" hidden>
            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path
                d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z" /></svg>
          </label>

        </form>

        <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>

        <div class="md-header__source">
          <a href="https://github.com/google/flatbuffers"
            title="前往代码库（Go to repository）" class="md-source"
            data-md-component="source">
            <div class="md-source__icon md-icon">

              <svg xmlns="http://www.w3.org/2000/svg"
                viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path
                  d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2" /></svg>
            </div>
            <div class="md-source__repository">
              google/FlatBuffers
            </div>
          </a>
        </div>

      </nav>

    </header>

    <div class="md-container" data-md-component="container">

      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">

          <div class="md-sidebar md-sidebar--primary"
            data-md-component="sidebar" data-md-type="navigation">
            <div class="md-sidebar__scrollwrap">
              <div class="md-sidebar__inner">

                <nav class="md-nav md-nav--primary" aria-label="Navigation"
                  data-md-level="0">
                  <label class="md-nav__title" for="__drawer">
                    <a href="../index.html" title="FlatBuffers 文档（Docs）"
                      class="md-nav__button md-logo"
                      aria-label="FlatBuffers 文档（Docs）"
                      data-md-component="logo">

                      <img src="../assets/flatbuffers_logo.svg" alt="logo">

                    </a>
                    FlatBuffers 文档（Docs）
                  </label>

                  <div class="md-nav__source">
                    <a href="https://github.com/google/flatbuffers"
                      title="前往代码库（Go to repository）" class="md-source"
                      data-md-component="source">
                      <div class="md-source__icon md-icon">

                        <svg xmlns="http://www.w3.org/2000/svg"
                          viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path
                            d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2" /></svg>
                      </div>
                      <div class="md-source__repository">
                        google/FlatBuffers
                      </div>
                    </a>
                  </div>

                  <ul class="md-nav__list" data-md-scrollfix>

                    <li class="md-nav__item">
                      <a href="../index.html" class="md-nav__link">

                        <span class="md-ellipsis">
                          概述（Overview）
                        </span>

                      </a>
                    </li>

                    <li class="md-nav__item">
                      <a href="../quick_start/index.html" class="md-nav__link">

                        <span class="md-ellipsis">
                          快速入门（Quick Start）
                        </span>

                      </a>
                    </li>

                    <li class="md-nav__item">
                      <a href="../tutorial/index.html" class="md-nav__link">

                        <span class="md-ellipsis">
                          教程（Tutorial）
                        </span>

                      </a>
                    </li>

                    <li class="md-nav__item md-nav__item--nested">

                      <input
                        class="md-nav__toggle md-toggle md-toggle--indeterminate"
                        type="checkbox" id="__nav_4">

                      <label class="md-nav__link" for="__nav_4"
                        id="__nav_4_label" tabindex="0">

                        <span class="md-ellipsis">
                          编译器（Compiler）(flatc)
                        </span>

                        <span class="md-nav__icon md-icon"></span>
                      </label>

                      <nav class="md-nav" data-md-level="1"
                        aria-labelledby="__nav_4_label" aria-expanded="false">
                        <label class="md-nav__title" for="__nav_4">
                          <span class="md-nav__icon md-icon"></span>
                          编译器（Compiler）(flatc)
                        </label>
                        <ul class="md-nav__list" data-md-scrollfix>

                          <li class="md-nav__item">
                            <a href="../building/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                构建（Building）
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../flatc/index.html" class="md-nav__link">

                              <span class="md-ellipsis">
                                使用（Using）
                              </span>

                            </a>
                          </li>

                        </ul>
                      </nav>

                    </li>

                    <li class="md-nav__item md-nav__item--nested">

                      <input
                        class="md-nav__toggle md-toggle md-toggle--indeterminate"
                        type="checkbox" id="__nav_5">

                      <label class="md-nav__link" for="__nav_5"
                        id="__nav_5_label" tabindex="0">

                        <span class="md-ellipsis">
                          模式定义（Schema）(.fbs)
                        </span>

                        <span class="md-nav__icon md-icon"></span>
                      </label>

                      <nav class="md-nav" data-md-level="1"
                        aria-labelledby="__nav_5_label" aria-expanded="false">
                        <label class="md-nav__title" for="__nav_5">
                          <span class="md-nav__icon md-icon"></span>
                          模式定义（Schema）(.fbs)
                        </label>
                        <ul class="md-nav__list" data-md-scrollfix>

                          <li class="md-nav__item">
                            <a href="../schema/index.html" class="md-nav__link">

                              <span class="md-ellipsis">
                                概述（Overview）
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../evolution/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                演变（Evolution）
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../grammar/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                语法（Grammar）
                              </span>

                            </a>
                          </li>

                        </ul>
                      </nav>

                    </li>

                    <li class="md-nav__item md-nav__item--nested">

                      <input
                        class="md-nav__toggle md-toggle md-toggle--indeterminate"
                        type="checkbox" id="__nav_6">

                      <label class="md-nav__link" for="__nav_6"
                        id="__nav_6_label" tabindex="0">

                        <span class="md-ellipsis">
                          语言指南（Language Guides）
                        </span>

                        <span class="md-nav__icon md-icon"></span>
                      </label>

                      <nav class="md-nav" data-md-level="1"
                        aria-labelledby="__nav_6_label" aria-expanded="false">
                        <label class="md-nav__title" for="__nav_6">
                          <span class="md-nav__icon md-icon"></span>
                          语言指南（Language Guides）
                        </label>
                        <ul class="md-nav__list" data-md-scrollfix>

                          <li class="md-nav__item">
                            <a href="../languages/c/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                C
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/cpp/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                C++
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/c_sharp/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                C#
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/dart/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Dart
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/go/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Go
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/java/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Java
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/javascript/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                JavasScript
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/kotlin/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Kotlin
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/lobster/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Lobster
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/lua/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Lua
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/php/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                PHP
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/python/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Python
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/rust/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Rust
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/swift/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                Swift
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../languages/typescript/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                TypeScript
                              </span>

                            </a>
                          </li>

                        </ul>
                      </nav>

                    </li>

                    <li class="md-nav__item">
                      <a href="../support/index.html" class="md-nav__link">

                        <span class="md-ellipsis">
                          支持的配置（Supported Configurations）
                        </span>

                      </a>
                    </li>

                    <li class="md-nav__item">
                      <a href="../white_paper/index.html" class="md-nav__link">

                        <span class="md-ellipsis">
                          白皮书（White Paper）
                        </span>

                      </a>
                    </li>

                    <li
                      class="md-nav__item md-nav__item--active md-nav__item--nested">

                      <input class="md-nav__toggle md-toggle " type="checkbox"
                        id="__nav_9" checked>

                      <label class="md-nav__link" for="__nav_9"
                        id="__nav_9_label" tabindex="0">

                        <span class="md-ellipsis">
                          高级（Advanced）
                        </span>

                        <span class="md-nav__icon md-icon"></span>
                      </label>

                      <nav class="md-nav" data-md-level="1"
                        aria-labelledby="__nav_9_label" aria-expanded="true">
                        <label class="md-nav__title" for="__nav_9">
                          <span class="md-nav__icon md-icon"></span>
                          高级（Advanced）
                        </label>
                        <ul class="md-nav__list" data-md-scrollfix>

                          <li class="md-nav__item">
                            <a href="../internals/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                FlatBuffers 内部结构（Internals）
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item">
                            <a href="../intermediate_representation/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                中间表示（Intermediate Representation）
                              </span>

                            </a>
                          </li>

                          <li class="md-nav__item md-nav__item--active">

                            <input class="md-nav__toggle md-toggle"
                              type="checkbox" id="__toc">

                            <label class="md-nav__link md-nav__link--active"
                              for="__toc">

                              <span class="md-ellipsis">
                                注释缓冲区（Annotating Buffers）(.afb)
                              </span>

                              <span class="md-nav__icon md-icon"></span>
                            </label>

                            <a href="index.html"
                              class="md-nav__link md-nav__link--active">

                              <span class="md-ellipsis">
                                注释缓冲区（Annotating Buffers）(.afb)
                              </span>

                            </a>

                            <nav class="md-nav md-nav--secondary"
                              aria-label="目录（Table of contents）">

                              <label class="md-nav__title" for="__toc">
                                <span class="md-nav__icon md-icon"></span>
                                目录（Table of contents）
                              </label>
                              <ul class="md-nav__list" data-md-component="toc"
                                data-md-scrollfix>

                                <li class="md-nav__item">
                                  <a href="#annotating" class="md-nav__link">
                                    <span class="md-ellipsis">
                                      注释（Annotating）
                                    </span>
                                  </a>

                                  <nav class="md-nav"
                                    aria-label="注释（Annotating）">
                                    <ul class="md-nav__list">

                                      <li class="md-nav__item">
                                        <a href="#example" class="md-nav__link">
                                          <span class="md-ellipsis">
                                            示例（Example）
                                          </span>
                                        </a>

                                      </li>

                                    </ul>
                                  </nav>

                                </li>

                                <li class="md-nav__item">
                                  <a href="#afb-text-format"
                                    class="md-nav__link">
                                    <span class="md-ellipsis">
                                      .afb 文本格式（Text Format）
                                    </span>
                                  </a>

                                  <nav class="md-nav"
                                    aria-label=".afb 文本格式（Text Format）">
                                    <ul class="md-nav__list">

                                      <li class="md-nav__item">
                                        <a href="#columns" class="md-nav__link">
                                          <span class="md-ellipsis">
                                            列（Columns）
                                          </span>
                                        </a>

                                      </li>

                                      <li class="md-nav__item">
                                        <a href="#binary-sections"
                                          class="md-nav__link">
                                          <span class="md-ellipsis">
                                            二进制节（Binary Sections）
                                          </span>
                                        </a>

                                      </li>

                                      <li class="md-nav__item">
                                        <a href="#binary-regions"
                                          class="md-nav__link">
                                          <span class="md-ellipsis">
                                            二进制区域（Binary Regions）
                                          </span>
                                        </a>

                                        <nav class="md-nav"
                                          aria-label="二进制区域（Binary Regions）">
                                          <ul class="md-nav__list">

                                            <li class="md-nav__item">
                                              <a href="#annotation-example"
                                                class="md-nav__link">
                                                <span class="md-ellipsis">
                                                  注释示例（Annotation Example）
                                                </span>
                                              </a>

                                            </li>

                                          </ul>
                                        </nav>

                                      </li>

                                      <li class="md-nav__item">
                                        <a href="#offsets" class="md-nav__link">
                                          <span class="md-ellipsis">
                                            偏移量（Offsets）
                                          </span>
                                        </a>

                                      </li>

                                    </ul>
                                  </nav>

                                </li>

                              </ul>

                            </nav>

                          </li>

                          <li class="md-nav__item">
                            <a href="../benchmarks/index.html"
                              class="md-nav__link">

                              <span class="md-ellipsis">
                                基准测试（Benchmarks）
                              </span>

                            </a>
                          </li>

                        </ul>
                      </nav>

                    </li>

                    <li class="md-nav__item">
                      <a href="../flexbuffers/index.html" class="md-nav__link">

                        <span class="md-ellipsis">
                          FlexBuffers（无模式版本）(Schema-less version)
                        </span>

                      </a>
                    </li>

                    <li class="md-nav__item">
                      <a href="../contributing/index.html" class="md-nav__link">

                        <span class="md-ellipsis">
                          贡献（Contributing）
                        </span>

                      </a>
                    </li>

                  </ul>
                </nav>
              </div>
            </div>
          </div>

          <div class="md-sidebar md-sidebar--secondary"
            data-md-component="sidebar" data-md-type="toc">
            <div class="md-sidebar__scrollwrap">
              <div class="md-sidebar__inner">

                <nav class="md-nav md-nav--secondary"
                  aria-label="目录（Table of contents）">

                  <label class="md-nav__title" for="__toc">
                    <span class="md-nav__icon md-icon"></span>
                    目录（Table of contents）
                  </label>
                  <ul class="md-nav__list" data-md-component="toc"
                    data-md-scrollfix>

                    <li class="md-nav__item">
                      <a href="#annotating" class="md-nav__link">
                        <span class="md-ellipsis">
                          注释（Annotating）
                        </span>
                      </a>

                      <nav class="md-nav" aria-label="注释（Annotating）">
                        <ul class="md-nav__list">

                          <li class="md-nav__item">
                            <a href="#example" class="md-nav__link">
                              <span class="md-ellipsis">
                                示例（Example）
                              </span>
                            </a>

                          </li>

                        </ul>
                      </nav>

                    </li>

                    <li class="md-nav__item">
                      <a href="#afb-text-format" class="md-nav__link">
                        <span class="md-ellipsis">
                          .afb 文本格式（Text Format）
                        </span>
                      </a>

                      <nav class="md-nav" aria-label=".afb 文本格式（Text Format）">
                        <ul class="md-nav__list">

                          <li class="md-nav__item">
                            <a href="#columns" class="md-nav__link">
                              <span class="md-ellipsis">
                                列（Columns）
                              </span>
                            </a>

                          </li>

                          <li class="md-nav__item">
                            <a href="#binary-sections" class="md-nav__link">
                              <span class="md-ellipsis">
                                二进制节（Binary Sections）
                              </span>
                            </a>

                          </li>

                          <li class="md-nav__item">
                            <a href="#binary-regions" class="md-nav__link">
                              <span class="md-ellipsis">
                                二进制区域（Binary Regions）
                              </span>
                            </a>

                            <nav class="md-nav"
                              aria-label="二进制区域（Binary Regions）">
                              <ul class="md-nav__list">

                                <li class="md-nav__item">
                                  <a href="#annotation-example"
                                    class="md-nav__link">
                                    <span class="md-ellipsis">
                                      注释示例（Annotation Example）
                                    </span>
                                  </a>

                                </li>

                              </ul>
                            </nav>

                          </li>

                          <li class="md-nav__item">
                            <a href="#offsets" class="md-nav__link">
                              <span class="md-ellipsis">
                                偏移量（Offsets）
                              </span>
                            </a>

                          </li>

                        </ul>
                      </nav>

                    </li>

                  </ul>

                </nav>
              </div>
            </div>
          </div>

          <div class="md-content" data-md-component="content">
            <article class="md-content__inner md-typeset">

              <a
                href="https://github.com/google/flatbuffers/edit/master/docs/source/annotation.md"
                title="编辑此页面（Edit this page）"
                class="md-content__button md-icon">

                <svg xmlns="http://www.w3.org/2000/svg"
                  viewBox="0 0 24 24"><path
                    d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z" /></svg>
              </a>

              <h1 id="annotating-flatbuffers">FlatBuffers 注释（Annotating
                FlatBuffers）</h1>
              <p>这提供了一种方法，可以使用模式（schema）对 flatbuffer
                二进制数据进行逐字节的注释。这对开发目的和理解内部格式的细节非常有用。</p>
              <h2 id="annotating">注释（Annotating）</h2>
              <p>给定一个<code>模式（schema）</code>，可以是纯文本格式（<code>.fbs</code>）或二进制模式（<code>.bfbs</code>），以及由该<code>模式</code>创建的<code>二进制</code>文件。您可以使用以下命令对它们进行注释：</p>
              <div
                class="highlight"><pre><span></span><code>flatc<span class="w"> </span>--annotate<span class="w"> </span>SCHEMA<span class="w"> </span>--<span class="w"> </span>BINARY_FILES...
</code></pre></div>
              <p>这将生成一组注释文件（<code>.afb</code> 已注释的 FlatBuffer），对应于输入的二进制文件。</p>
              <h3 id="example">示例（Example）</h3>
              <p>取自 <a
                  href="https://github.com/google/flatbuffers/tree/master/tests/annotated_binary">tests/annotated_binary</a>。</p>
              <div
                class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>tests/annotated_binary
../../flatc<span class="w"> </span>--annotate<span class="w"> </span>annotated_binary.fbs<span class="w"> </span>--<span class="w"> </span>annotated_binary.bin
</code></pre></div>
              <p>这将在当前目录中生成一个 <code>annotated_binary.afb</code> 文件。</p>
              <p><code>annotated_binary.bin</code> 是
                <code>annotated_binary.json</code> 中包含的数据的 flatbuffer
                二进制文件，它是通过以下命令创建的：</p>
              <div
                class="highlight"><pre><span></span><code>..<span class="se">\.</span>.<span class="se">\f</span>latc<span class="w"> </span>-b<span class="w"> </span>annotated_binary.fbs<span class="w"> </span>annotated_binary.json
</code></pre></div>
              <h2 id="afb-text-format">.afb 文本格式（Text Format）</h2>
              <p>目前有一个内置的基于文本的格式用于输出注释。完整示例可在此处查看：
                <a
                  href="https://github.com/google/flatbuffers/blob/master/tests/annotated_binary/annotated_binary.afb"><code>annotated_binary.afb</code></a></p>
              <p>数据被组织为一个具有固定<a
                  href="#columns">列（columns）</a>的表格，分组为二进制<a
                  href="#binary-sections">节（sections）</a>和<a
                  href="#binary-regions">区域（regions）</a>，从二进制文件的开始（偏移量
                <code>0</code>）开始。</p>
              <h3 id="columns">列（Columns）</h3>
              <p>列的内容如下：</p>
              <ol>
                <li>
                  <p>从二进制文件开始的偏移量，以十六进制格式表示（例如 <code>+0x003c</code>）。</p>
                  <p>前缀 <code>+</code> 的添加是为了使搜索偏移量（与一些随机值相比）更容易一些。</p>
                </li>
                <li>
                  <p>原始二进制数据，以十六进制格式表示。</p>
                  <p>这是缓冲区内部使用的小端格式，也是您在正常的二进制文本查看器中看到的内容。</p>
                </li>
                <li>
                  <p>数据的类型。</p>
                  <p>这可能是模式中指定的类型或一些内部定义的类型：</p>
                  <table>
                    <thead>
                      <tr>
                        <th>内部类型（Internal Type）</th>
                        <th>用途（Purpose）</th>
                      </tr>
                    </thead>
                    <tbody>
                      <tr>
                        <td><code>VOffset16</code></td>
                        <td>虚拟表偏移量，相对于表偏移量</td>
                      </tr>
                      <tr>
                        <td><code>UOffset32</code></td>
                        <td>无符号偏移量，相对于当前偏移量</td>
                      </tr>
                      <tr>
                        <td><code>SOffset32</code></td>
                        <td>有符号偏移量，相对于当前偏移量</td>
                      </tr>
                    </tbody>
                  </table>
                </li>
                <li>
                  <p>数据的值。</p>
                  <p>这显示为大端格式，通常为人类阅读编写（例如 <code>0x0013</code>）。以及"转换"值（例如
                    <code>0x0013</code>在十进制中是<code>19</code>）括号中。</p>
                </li>
                <li>
                  <p>关于特定数据的注释。</p>
                  <p>这描述了数据的用途，可能是内部使用，或与模式相关。</p>
                </li>
              </ol>
              <h3 id="binary-sections">二进制节（Binary Sections）</h3>
              <p>文件被分解为二进制节，由逻辑上分组在一起的连续<a
                  href="#binary-regions">二进制区域</a>组成。例如，一个二进制节可能是一个 flatbuffer
                <code>Table</code> 的单个实例或其
                <code>vtable</code>。这些节可能带有与输入模式中定义的相关类型的名称标签。</p>
              <p>一个与用户定义的 <code>AnnotateBinary.Bar</code> 表关联的
                <code>vtable</code> 二进制节的示例。</p>
              <div
                class="highlight"><pre><span></span><code>vtable (AnnotatedBinary.Bar):
  +0x00A0 | 08 00      | uint16_t   | 0x0008 (8)   | size of this vtable
  +0x00A2 | 13 00      | uint16_t   | 0x0013 (19)  | size of referring table
  +0x00A4 | 08 00      | VOffset16  | 0x0008 (8)   | offset to field `a` (id: 0)
  +0x00A6 | 04 00      | VOffset16  | 0x0004 (4)   | offset to field `b` (id: 1)
</code></pre></div>
              <p>这些纯粹是注释性的，flatbuffer 本身中没有关于这些区域的嵌入信息。</p>
              <h3 id="binary-regions">二进制区域（Binary Regions）</h3>
              <p>二进制区域是连续的字节区域，它们被组合在一起形成某种值，例如一个<code>标量（scalar）</code>或标量数组。如果区域大小较大，二进制区域可能会分布在多个文本行上。</p>
              <h4 id="annotation-example">注释示例（Annotation Example）</h4>
              <p>看一个二进制区域的示例：</p>
              <div
                class="highlight"><pre><span></span><code>vtable (AnnotatedBinary.Bar):
  +0x00A0 | 08 00      | uint16_t   | 0x0008 (8)   | size of this vtable
</code></pre></div>
              <p>第一列（<code>+0x00A0</code>）是从缓冲区开始到该区域的偏移量。</p>
              <p>第二列是组成该区域的原始字节（十六进制）。这些以 flatbuffers 用于传输格式的小端格式表示。</p>
              <p>第三列是解释字节的类型。对于上面的例子，类型是 <code>uint16_t</code>，这是一个 16
                位无符号整数类型。</p>
              <p>第四列显示原始字节作为一个压缩的大端值。原始字节以这种方式重复是因为以大端格式（例如，<code>0x0008</code>）阅读数据更直观。该值后面跟着该值的十进制表示（例如，<code>(8)</code>）。对于字符串，则显示原始字符串值。</p>
              <p>第五列是关于该值的文本注释。提供了尽可能多的已知元数据。</p>
              <h3 id="offsets">偏移量（Offsets）</h3>
              <p>如果第 3 列中的类型是绝对偏移量（<code>SOffet32</code> 或
                <code>Offset32</code>），第 4 列还会显示一个 <code>Loc: +0x025A</code>
                值，表示该区域在二进制文件中指向的位置。这些值是从文件开始的绝对值，它们从第 4 列中的原始值计算出来，取决于上下文。</p>

            </article>
          </div>

          <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

          <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>

      </main>

      <footer class="md-footer">

        <nav class="md-footer__inner md-grid" aria-label="页脚（Footer）">

          <a href="../intermediate_representation/index.html"
            class="md-footer__link md-footer__link--prev"
            aria-label="上一页：中间表示（Intermediate Representation）">
            <div class="md-footer__button md-icon">

              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path
                  d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z" /></svg>
            </div>
            <div class="md-footer__title">
              <span class="md-footer__direction">
                上一页（Previous）
              </span>
              <div class="md-ellipsis">
                中间表示（Intermediate Representation）
              </div>
            </div>
          </a>

          <a href="../benchmarks/index.html"
            class="md-footer__link md-footer__link--next"
            aria-label="下一页：基准测试（Benchmarks）">
            <div class="md-footer__title">
              <span class="md-footer__direction">
                下一页（Next）
              </span>
              <div class="md-ellipsis">
                基准测试（Benchmarks）
              </div>
            </div>
            <div class="md-footer__button md-icon">

              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path
                  d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z" /></svg>
            </div>
          </a>

        </nav>

        <div class="md-footer-meta md-typeset">
          <div class="md-footer-meta__inner md-grid">
            <div class="md-copyright">

              <div class="md-copyright__highlight">
                版权所有 &copy; 2025 Google
              </div>

              使用
              <a href="https://squidfunk.github.io/mkdocs-material/"
                target="_blank" rel="noopener">
                Material for MkDocs
              </a>
              制作

            </div>

            <div class="md-social">

              <a href="https://github.com/google/flatbuffers" target="_blank"
                rel="noopener" title="github.com" class="md-social__link">
                <svg xmlns="http://www.w3.org/2000/svg"
                  viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path
                    d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2" /></svg>
              </a>

              <a href="https:///discord.gg/6qgKs3R" target="_blank"
                rel="noopener" title class="md-social__link">
                <svg xmlns="http://www.w3.org/2000/svg"
                  viewBox="0 0 640 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path
                    d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485 485 0 0 0 404.081 32.03a1.82 1.82 0 0 0-1.923.91 338 338 0 0 0-14.9 30.6 447.9 447.9 0 0 0-134.426 0 310 310 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.7 483.7 0 0 0-119.688 37.107 1.7 1.7 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.02 2.02 0 0 0 .765 1.375 487.7 487.7 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348 348 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321 321 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251 251 0 0 0 9.109-7.137 1.82 1.82 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.81 1.81 0 0 1 1.924.233 235 235 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.4 301.4 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391 391 0 0 0 30.014 48.815 1.86 1.86 0 0 0 2.063.7A486 486 0 0 0 610.7 405.729a1.88 1.88 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541M222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241m195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241" /></svg>
              </a>

              <a href="https://twitter.com/dbaileychess" target="_blank"
                rel="noopener" title="twitter.com" class="md-social__link">
                <svg xmlns="http://www.w3.org/2000/svg"
                  viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path
                    d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8l164.9-188.5L26.8 48h145.6l100.5 132.9zm-24.8 373.8h39.1L151.1 88h-42z" /></svg>
              </a>

            </div>

          </div>
        </div>
      </footer>

    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>

    <script id="__config"
      type="application/json">{"base": "..", "features": ["content.code.annotate", "content.tabs.link", "navigation.expand", "navigation.footer", "header.autohide", "content.action.edit"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

    <script src="../assets/javascripts/bundle.c8b220af.min.js"></script>

  </body>

  <!-- Mirrored from flatbuffers.dev/annotation/ by HTTrack Website Copier/3.x [XR&CO'2014], Thu, 08 May 2025 07:01:36 GMT -->
</html>